Various documentation fixes
authorTimm Bäder <mail@baedert.org>
Mon, 8 Feb 2016 21:49:01 +0000 (22:49 +0100)
committerTimm Bäder <mail@baedert.org>
Mon, 8 Feb 2016 21:56:52 +0000 (22:56 +0100)
Always have Since: annotations at the very bottom, use the correct
ClassName::signal-name/ClassName:property-name syntax, fix a few typos
in type names, wrong function names, non-existing type names, etc.

13 files changed:
gtk/gtkfontchooserwidget.c
gtk/gtkgesture.c
gtk/gtkgesturedrag.c
gtk/gtkgesturelongpress.c
gtk/gtklabel.c
gtk/gtklistbox.c
gtk/gtkmodelbutton.c
gtk/gtknotebook.c
gtk/gtkshortcutsshortcut.c
gtk/gtkshortcutswindow.c
gtk/gtkspinbutton.c
gtk/gtkstack.c
gtk/gtkstylecontext.c

index 0f6208285eb95b4b4c92bfd967f75e6dad90251a..b7fbef1f908453e2c93550e181e26fc98a52a83e 100644 (file)
  * To change the text which is shown in the preview area, use
  * gtk_font_chooser_set_preview_text().
  *
- * Since: 3.2
- *
  * # CSS nodes
  *
  * GtkFontChooserWidget has a single CSS node with name fontchooser.
+ *
+ * Since: 3.2
  */
 
 
index 9fa1cf3a26775237e864a744afd09bd0460df3bd..47fa3c56ceb252c3bbfc5ed2b6800d9ff3ea20bb 100644 (file)
@@ -54,8 +54,8 @@
  * target widget, and gestures that are attached to containers above the widget
  * get a chance to interact with the event before it reaches the target.
  *
- * After the capture phase, GTK+ emits the traditional #GtkWidget::button-press,
- * #GtkWidget::button-release, #GtkWidget::touch-event, etc signals. Gestures 
+ * After the capture phase, GTK+ emits the traditional #GtkWidget::button-press-event,
+ * #GtkWidget::button-release-event, #GtkWidget::touch-event, etc signals. Gestures
  * with the %GTK_PHASE_TARGET phase are fed events from the default #GtkWidget::event
  * handlers.
  *
index 0c5a7859e83976d5b93b5273af26e1dd3d50a210..59fdc2aa62918cf8316a5f66c07661cdb7c49fb8 100644 (file)
@@ -25,8 +25,8 @@
  *
  * #GtkGestureDrag is a #GtkGesture implementation that recognizes drag
  * operations. The drag operation itself can be tracked throught the
- * #GtkGestureDrag:drag-begin, #GtkGestureDrag:drag-update and
- * #GtkGestureDrag:drag-end signals, or the relevant coordinates be
+ * #GtkGestureDrag::drag-begin, #GtkGestureDrag::drag-update and
+ * #GtkGestureDrag::drag-end signals, or the relevant coordinates be
  * extracted through gtk_gesture_drag_get_offset() and
  * gtk_gesture_drag_get_start_point().
  */
index 405068db532fd13f7ad55d5d83802b27cd28d046..8cbcce76e7b8568ac37d43ad041799221b0830e7 100644 (file)
@@ -309,7 +309,7 @@ gtk_gesture_long_press_class_init (GtkGestureLongPressClass *klass)
    * @gesture: the object which received the signal
    *
    * This signal is emitted whenever a press moved too far, or was released
-   * before #GtkGestureLongPress:pressed happened.
+   * before #GtkGestureLongPress::pressed happened.
    *
    * Since: 3.14
    */
index e1f55f6ec7b9b22379ac29923244e3bb2afcf863..c0b37772ab43e4204578b2c1bf4699dad336906c 100644 (file)
  *
  * gtk_label_set_justify() sets how the lines in a label align
  * with one another. If you want to set how the label as a whole
- * aligns in its available space, see the #GtkWidget::halign and
+ * aligns in its available space, see the #GtkWidget:halign and
  * #GtkWidget:valign properties.
  *
  * The #GtkLabel:width-chars and #GtkLabel:max-width-chars properties
index f2a35b850e5f533e2313186a4ebe59b6e66c41ed..59a46b88cdddbbdcb92d6855e3f9e05674324855 100644 (file)
@@ -3592,7 +3592,7 @@ gtk_list_box_row_get_activatable (GtkListBoxRow *row)
 
 /**
  * gtk_list_box_row_set_selectable:
- * @row: a #GTkListBoxrow
+ * @row: a #GtkListBoxRow
  * @selectable: %TRUE to mark the row as selectable
  *
  * Set the #GtkListBoxRow:selectable property for this row.
index cbeab657834947d09a579208ebcf39f9a8d5a3f9..0e941c2808063969670f3fdcb9d9ac337fe95f83 100644 (file)
  * ╰── check
  * ]|
  *
- * Iconic model buttons (see #GtkModelButton::iconic) change the name of
+ * Iconic model buttons (see #GtkModelButton:iconic) change the name of
  * their main node to button and add a .model style class to it. The indicator
  * subnode is invisible in this case.
  */
index a4d97ed1ecef2cb39aa911ed882ed8b84e06730c..26de2bc86aa2ce3e952958556eb3dd89e2eceafb 100644 (file)
  * name arrow are placed as first and last child of the tabs node.
  *
  * The main node gets the .frame style class when the notebook
- * has a border (see gtk_notebook_set_has_border()).
+ * has a border (see gtk_notebook_set_show_border()).
  *
  * The header node gets one of the style class .top, .bottom,
  * .left or .right, depending on where the tabs are placed. For
index cd446740c3ac534827cea9a11cbe11543dfedde6..018322c827e095cb5f6316e019908bf84a9c80f8 100644 (file)
@@ -464,7 +464,7 @@ gtk_shortcuts_shortcut_class_init (GtkShortcutsShortcutClass *klass)
    * GtkShortcutsShortcut:accelerator:
    *
    * The accelerator(s) represented by this object. This property is used
-   * if #GtkShorcutsShortcut:shortcut-type is set to #GTK_SHORTCUT_ACCELERATOR.
+   * if #GtkShortcutsShortcut:shortcut-type is set to #GTK_SHORTCUT_ACCELERATOR.
    *
    * The syntax of this property is (an extension of) the syntax understood by
    * gtk_accelerator_parse(). Multiple accelerators can be specified by separating
index 6edb4ee7567717a67a19d4d5107857f18eed9f37..109c17fc2fbbc7340d737344528bd85f4ee8a2c4 100644 (file)
@@ -45,7 +45,7 @@
  * The recommended way to construct a GtkShortcutsWindow is with GtkBuilder,
  * by populating a #GtkShortcutsWindow with one or more #GtkShortcutsSection
  * objects, which contain #GtkShortcutsGroups that in turn contain objects of
- * class #GtkShortcutsShortcut or #GtkShortcutsGesture.
+ * class #GtkShortcutsShortcut.
  *
  * # A simple example:
  *
index 7961dc9fca8c2362dde01f8452f95f9e1f16bbb2..e76a1e737f6afee5121acd021d7658aca3f65578 100644 (file)
@@ -84,7 +84,7 @@
  * properties. Note that GtkSpinButton will by default make its entry
  * large enough to accomodate the lower and upper bounds of the adjustment,
  * which can lead to surprising results. Best practice is to set both
- * the #GtkEntry::width-chars and #GtkEntry::max-width-chars poperties
+ * the #GtkEntry:width-chars and #GtkEntry:max-width-chars poperties
  * to the desired number of characters to display in the entry.
  *
  * # CSS nodes
index 998f08f5755d8091e53156a1c82a9eada730ba47..94389333ada69116f1619aac43910129b434fec0 100644 (file)
@@ -1690,7 +1690,7 @@ gtk_stack_get_transition_running (GtkStack *stack)
  * @interpolate_size: the new value
  *
  * Sets whether or not @stack will interpolate its size when
- * changing the visible child. If the #GtkStack::interpolate-size
+ * changing the visible child. If the #GtkStack:interpolate-size
  * property is set to %TRUE, @stack will interpolate its size between
  * the current one and the one it'll take after changing the
  * visible child, according to the set transition duration.
index 7d5664af8044c63411263b7187e4d863aa0fc156..bfb094838bfae7f5cfe6b4029fe6991f792f2316 100644 (file)
@@ -2568,7 +2568,7 @@ gtk_style_context_get_background_color (GtkStyleContext *context,
  *
  * Since: 3.0
  *
- * Deprecated: 3.16: Use gtk_render_border() instead.
+ * Deprecated: 3.16: Use gtk_render_frame() instead.
  **/
 void
 gtk_style_context_get_border_color (GtkStyleContext *context,